/*
 *  Cero Project - Copyright   2006 The Cero Developement Team 
 *  (Michael Laguerre, Camille Roux, Matthieu Segret, Mathieu Sivade) 
 * 
 *  This program is free software; you can redistribute it and/or modify it 
 *  under the terms of the GNU General Public License as published by the Free 
 *  Software Foundation; either version 2 of the License, or (at your option) 
 *  any later version.
 * 
 *  This program is distributed in the hope that it will be useful, but 
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 *  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
 *  for more details.
 */

package org.ceroproject.games;

public interface Card {
	/**
	 * Returns the id of the current card. The id links to an unique card in
	 * this game. Ids may differ from a game to another, as if you were using
	 * different decks between each game. Id must therefore not be shared, even
	 * amongst similar cards which are physically different.
	 * 
	 * @return the id of the current card.
	 */
	int getCardId();

	/**
	 * Returns the name of the card
	 * 
	 * @return the name of the card
	 */
	String getCardName();

	/**
	 * Returns the hidden card corresponding to the card
	 * 
	 * @return a hidden card with a valid ID
	 */
	Card getHiddenCard();

	/**
	 * Returns whether this card is hidden or not
	 * 
	 * @return true if it is hidden, false otherwise
	 */
	boolean isHiddenCard();

	/**
	 * Returns the name of the cardset. It will be something like "32",
	 * "52joker", "tarot", "Munchkin", "Citadelles", etc
	 * 
	 * @return the name of the cardset this card belongs to.
	 */
	String getCardSetName();
	
	public String toString();
}
